Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Workspace]Move set default data source before workspace update #7636

Merged
merged 3 commits into from
Aug 8, 2024
Merged

[Workspace]Move set default data source before workspace update #7636

merged 3 commits into from
Aug 8, 2024

Conversation

wanglam
Copy link
Contributor

@wanglam wanglam commented Aug 7, 2024 •
edited
Loading

Description

This PR is for fixing dev server crash after un-assign self as a workspace owner. In previous implementation, the set default data source will be called after permission updated. The user won't have write permission to the workspace. So the set default data source operation will be failed and throw exception. Then there will be a unhandled promise rejection. Move set default data source before workspace update to avoid this issue.

Issues Resolved

#7639

Screenshot

No UI Changes.

Testing the changes

  • Clone branch and run yarn osd bootstrap
  • Add below configs in config/opensearch_dashboards.yml
workspace.enabled: true
savedObjects.permission.enabled: true
data_source.enabled: true
uiSettings:
  overrides:
    'home:useNewHomePage': true
opensearchDashboards.dashboardAdmin.users: ['admin']
  • Run yarn start --no-base-path
  • Login with admin user and create a test user with kibanauser role
  • Create a workspace and set test user as a workspace owner
  • Login with test user and go to workspace detail page
  • Remove test user in Collaborator tab
  • Click save button and then it will show success toasts and redirect workspace not found page

Changelog

  • fix: [Workspace] Move set default source order to avoid dev server crash

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@wanglam
Move set default data source before workspace update
c0991d6 
Signed-off-by: Lin Wang <wonglam@amazon.com>
@codecov Codecov
Copy link

codecov bot commented Aug 7, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.68%. Comparing base (a65a8aa) to head (f1658dd).
Report is 221 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #7636      +/-   ##
==========================================
+ Coverage   63.66%   63.68%   +0.01%     
==========================================
  Files        3633     3633              
  Lines       80065    80107      +42     
  Branches    12685    12691       +6     
==========================================
+ Hits        50973    51013      +40     
- Misses      25986    25987       +1     
- Partials     3106     3107       +1
Flag Coverage Δ
Linux_1 30.60% <100.00%> (+0.05%) ⬆️
Linux_2 55.58% <ø> (ø)
Linux_3 40.56% <ø> (-0.01%) ⬇️
Linux_4 31.30% <ø> (+<0.01%) ⬆️
Windows_1 30.62% <100.00%> (+0.05%) ⬆️
Windows_2 55.53% <ø> (ø)
Windows_3 40.57% <ø> (+<0.01%) ⬆️
Windows_4 31.30% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wanglam wanglam changed the title Move set default data source before workspace update [Workspace]Move set default data source before workspace update Aug 7, 2024
@wanglam wanglam marked this pull request as ready for review August 7, 2024 09:55
SuZhou-Joe
SuZhou-Joe previously approved these changes Aug 7, 2024
View reviewed changes
@Hailong-am
Copy link
Collaborator

So the set default data source operation will be failed and throw exception. Then there will be a unhandled promise rejection

but we have try catch for whole update operation, not sure why it does not catch it and cause server crash

https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/workspace/server/workspace_client.ts#L221-L293

@wanglam
Copy link
Contributor Author

wanglam commented Aug 7, 2024 •
edited
Loading

So the set default data source operation will be failed and throw exception. Then there will be a unhandled promise rejection

but we have try catch for whole update operation, not sure why it does not catch it and cause server crash

https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/workspace/server/workspace_client.ts#L221-L293

The checkAndSetDefaultDataSource‎ is an async function but we didn't wait it complete in the workspaceClient.update method. The error occurs after workspaceClient.update method executed complete, so there will be an unhandled promise rejection.

@Hailong-am
Copy link
Collaborator

So the set default data source operation will be failed and throw exception. Then there will be a unhandled promise rejection

but we have try catch for whole update operation, not sure why it does not catch it and cause server crash
https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/workspace/server/workspace_client.ts#L221-L293

The checkAndSetDefaultDataSource‎ is an async function but we didn't wait it complete in the workspaceClient.update method. The error occurs after workspaceClient.update method executed complete, so there will be an unhandled promise rejection.

I see, thanks!

@ruanyl
Copy link
Member

ruanyl commented Aug 8, 2024

@wanglam I guess the issue only happens when user self-removed from the workspace and assign/un-assign data source at the same time?

@wanglam
Copy link
Contributor Author

wanglam commented Aug 8, 2024

@wanglam I guess the issue only happens when user self-removed from the workspace and assign/un-assign data source at the same time?

@ruanyl I think it's not related to the assign/un-assign data source, the default data source will always be set to undefined if passed data sources is empty. In this case, I didn't change the data sources of workspace.

@wanglam
Add comment for move set default data source before workspace update
f1658dd 
Signed-off-by: Lin Wang <wonglam@amazon.com>
@SuZhou-Joe SuZhou-Joe merged commit 761b2ff into opensearch-project:main Aug 8, 2024
66 of 67 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Aug 8, 2024
@github-actions @opensearch-changeset-bot
[Workspace]Move set default data source before workspace update (#7636)
8541642 
* Move set default data source before workspace update

Signed-off-by: Lin Wang <wonglam@amazon.com>

* Changeset file for PR #7636 created/updated

* Add comment for move set default data source before workspace update

Signed-off-by: Lin Wang <wonglam@amazon.com>

---------

Signed-off-by: Lin Wang <wonglam@amazon.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
(cherry picked from commit 761b2ff)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Aug 8, 2024
Merged
@SuZhou-Joe SuZhou-Joe mentioned this pull request Aug 9, 2024
Closed
SuZhou-Joe pushed a commit that referenced this pull request Aug 9, 2024
@opensearch-trigger-bot @github-actions @opensearch-changeset-bot
[Workspace]Move set default data source before workspace update (#7636)…
64edc4f 
… (#7664)

* Move set default data source before workspace update



* Changeset file for PR #7636 created/updated

* Add comment for move set default data source before workspace update



---------



(cherry picked from commit 761b2ff)

Signed-off-by: Lin Wang <wonglam@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Hailong-am Hailong-am Hailong-am approved these changes

@SuZhou-Joe SuZhou-Joe SuZhou-Joe approved these changes

@ruanyl ruanyl ruanyl approved these changes

@ananzh ananzh Awaiting requested review from ananzh ananzh is a code owner

@kavilla kavilla Awaiting requested review from kavilla kavilla is a code owner

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@ashwin-pc ashwin-pc Awaiting requested review from ashwin-pc ashwin-pc is a code owner

@joshuarrrr joshuarrrr Awaiting requested review from joshuarrrr joshuarrrr is a code owner

@abbyhu2000 abbyhu2000 Awaiting requested review from abbyhu2000 abbyhu2000 is a code owner

@zengyan-amazon zengyan-amazon Awaiting requested review from zengyan-amazon zengyan-amazon is a code owner

@zhongnansu zhongnansu Awaiting requested review from zhongnansu zhongnansu is a code owner

@manasvinibs manasvinibs Awaiting requested review from manasvinibs manasvinibs is a code owner

@ZilongX ZilongX Awaiting requested review from ZilongX ZilongX is a code owner

@Flyingliuhub Flyingliuhub Awaiting requested review from Flyingliuhub Flyingliuhub is a code owner

@curq curq Awaiting requested review from curq curq is a code owner

@bandinib-amzn bandinib-amzn Awaiting requested review from bandinib-amzn bandinib-amzn is a code owner

@BionIT BionIT Awaiting requested review from BionIT BionIT is a code owner

@xinruiba xinruiba Awaiting requested review from xinruiba xinruiba is a code owner

@zhyuanqi zhyuanqi Awaiting requested review from zhyuanqi zhyuanqi is a code owner

@mengweieric mengweieric Awaiting requested review from mengweieric mengweieric is a code owner

@LDrago27 LDrago27 Awaiting requested review from LDrago27 LDrago27 is a code owner

@virajsanghvi virajsanghvi Awaiting requested review from virajsanghvi virajsanghvi is a code owner

@sejli sejli Awaiting requested review from sejli sejli is a code owner

@joshuali925 joshuali925 Awaiting requested review from joshuali925 joshuali925 is a code owner

Assignees
No one assigned
Labels
backport 2.x in-next seasoned-contributor v2.17.0 workspace
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@wanglam @Hailong-am @ruanyl @SuZhou-Joe @AMoo-Miki